<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>mechanoChemIGA: Code Structure</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">mechanoChemIGA
   &#160;<span id="projectnumber">0.2.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="codestructure.html"><span>Code&#160;structure</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
      <li><a href="modules.html"><span>Functions</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="https://github.com/mechanoChem/mechanoChem"><span>GitHub&#160;code&#160;repo</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">Code Structure </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>The code is divided into three parts: the (optional) parameters file, user defined functions, and core functions. The parameters file includes the definition of parameters used in the simulation (mesh refinement, time step size, material parameters, etc.). The user defined functions is a list of functions that can/must be defined by the user. The <code>defineParameters</code> and <code>residual</code> functions (italicized) require a user definition; the remaining functions have default definitions that can be overridden by the user if desired. These user functions are called by the core functions, as shown in the following diagram.</p>
<div align="center">
<img src="dot_inline_dotgraph_1.png" alt="dot_inline_dotgraph_1.png" border="0" usemap="#dot_inline_dotgraph_1.map"/>
<map name="dot_inline_dotgraph_1.map" id="dot_inline_dotgraph_1.map"><area shape="rect" id="node11" href="group__user_functions.html#gadbccf6631ad847d5a681a548f921ef29" title="{&lt;B&gt;&lt;I&gt;defineParameters&lt;/I&gt;&lt;/B&gt;}" alt="" coords="233,209,397,239"/><area shape="rect" id="node9" href="group__user_functions.html#ga4bb6b6363788ea6d3af2c543955ee029" title="scalarInitialConditions" alt="" coords="221,99,408,130"/><area shape="rect" id="node10" href="group__user_functions.html#gac3c9dadedbc328dc0a3006f072b08a55" title="vectorInitialConditions" alt="" coords="221,154,408,185"/><area shape="rect" id="node12" href="mechano_chem_stab_2user_functions_8cc.html#acaf804e621998c5c9794a46d3212afbb" title="boundaryConditions" alt="" coords="229,263,400,294"/><area shape="rect" id="node13" href="group__user_functions.html#gab9195b3f02c923dafb2c742df293db7d" title="{&lt;B&gt;&lt;I&gt;residual&lt;/I&gt;&lt;/B&gt;}" alt="" coords="271,318,359,349"/><area shape="rect" id="node21" href="group__core_functions.html#gaaa30f566761cb94fc5aefe7affc203cc" title="QuadPtResidual" alt="" coords="528,318,672,349"/><area shape="rect" id="node14" href="group__user_functions.html#ga397c8fb1bf91992fb38944806aa864cf" title="loadStep" alt="" coords="270,373,359,403"/><area shape="rect" id="node15" href="group__user_functions.html#gae605154e592215f58a1b4c68396db2d0" title="adaptiveTimeStep" alt="" coords="235,427,394,458"/><area shape="rect" id="node16" href="mechano_chem_stab_2user_functions_8cc.html#a31a2f2e526abaf0b8a00c2623e14f22e" title="projectFields" alt="" coords="255,482,374,513"/><area shape="rect" id="node24" href="group__core_functions.html#ga3a0e7217998b15739effcfa4fbd10842" title="ProjectionResidual" alt="" coords="519,482,681,513"/><area shape="rect" id="node18" href="group__core_functions.html#ga20fdc6d97dce38bb3bc3f8f91ba1cade" title="FormInitialCondition" alt="" coords="514,154,686,185"/><area shape="rect" id="node19" href="group__core_functions.html#ga2a8d849923eaa1fd00d8c8d7ea96c121" title="Setup" alt="" coords="567,209,633,239"/><area shape="rect" id="node22" href="group__core_functions.html#ga143a878f6c274dcd5e8013788380316e" title="StepUpdate" alt="" coords="544,373,656,403"/></map>
</div>
 </div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
